home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / pcl / read.me < prev    next >
Text File  |  1993-07-07  |  7KB  |  152 lines
  1. CMU Common Lisp is a public domain implementation of Common Lisp.  Both
  2. sources and executables are freely available via anonymous FTP; this software
  3. is "as is", and has no warranty of any kind.  CMU and the authors assume no
  4. responsibility for the consequences of any use of this software.  See
  5. doc/release-notes.txt for a description of the state of the release you have.
  6.  
  7. The CMU Common Lisp project's goal is to develop a high quality public domain
  8. system, so we want your bug reports, bug fixes and enhancements.  However,
  9. staff limitations prevent us from providing extensive support to people outside
  10. of CMU.  We are looking for university and industrial affiliates to help us
  11. with porting and maintenance for hardware and software that is not widely used
  12. at CMU.
  13.  
  14. See "man cmucl" (man/man1/cmucl.1) for other general information.
  15.  
  16. Distribution:
  17.  
  18. CMU Common Lisp is only available via anonymous FTP.  We don't have the
  19. manpower to make tapes.  These are our distribution machines:
  20.     lisp-rt1.slisp.cs.cmu.edu (128.2.217.9)
  21.     lisp-rt2.slisp.cs.cmu.edu (128.2.217.10)
  22.  
  23. Log in with the user "anonymous" and "username@host" as password (i.e. your
  24. EMAIL address.)  When you log in, the current directory should be set to the
  25. CMU CL release area.  If you have any trouble with FTP access, please send mail
  26. to slisp@cs.cmu.edu.
  27.  
  28. The release area holds compressed tar files with names of the form:
  29.     <version>-<machine>_<os>.tar.Z
  30.     <version>-extra-<machine>_<os>.tar.Z
  31.  
  32. FTP compressed tar archives in binary mode.  To extract, "cd" to the
  33. directory that is to be the root of the tree, then type:
  34.     uncompress <file.tar.Z | tar xf - .
  35.  
  36. As of 12/11/92, the latest SunOS Sparc release is:
  37.     16f-sun4c_41.tar.Z (6.8 meg)
  38.     16f-extra-sun4c_41.tar.Z (3.5 meg)
  39.  
  40. The first file holds binaries and documentation for the basic Lisp system,
  41. while the second `-extra' file contains the Hemlock editor, the graphical
  42. inspector and the CLX interface to X11.  The basic configuration takes 16
  43. megabytes of disk space; adding the extras takes another 8 megabytes.  For
  44. installation directions, see the section "site initialization" in the README
  45. file at the root of the tree.
  46.  
  47. If poor network connections make it difficult to transfer a 10 meg file, the
  48. release is also available split into 2 megabyte chunks, suffixed `.0', `.1',
  49. etc.  To extract from multiple files, use:
  50.     cat file.tar.Z.* | uncompress | tar xf - .
  51.  
  52. The release area also contains source distributions and other binary
  53. distributions.  A listing of the current contents of the release area is in
  54. FILES.  Major release announcements will be made to comp.lang.lisp until there
  55. is enough volume to warrant a comp.lang.lisp.cmu.
  56.  
  57. SunOS credit:
  58.  
  59. The SunOS support was written by Miles Bader and Ted Dunning.
  60.  
  61. Site initialization:
  62.  
  63. To run CMU CL, place bin/ in PATH and setenv CMUCLLIB to point to lib/.  The
  64. file lib/site-init.lisp contains site-specific initialization, such as setting
  65. of the site name.  Any site-specific initialization should be placed in this
  66. file; this file can be compiled.  See bin/sample-wrapper for a shell script
  67. template that sets up environment variables and then runs CMU CL.  You may
  68. want to have your EMACS maintainer place doc/cmu-user.info in the info root, or
  69. you can setenv INFOPATH to include the doc/ directory.
  70.  
  71. To load in Hemlock or CLX and save an augmented Lisp image, run lib/config.
  72. This runs `lisp' on `lib/config.lisp', which uses an interactive dialog to
  73. determine what systems to load and where to save the result.  The default
  74. output is to overwrite library:lisp.core.  To avoid overwriting the running
  75. Lisp image, any existing image is renamed to `lisp.core.BAK'; this file may be
  76. manually deleted to save disk space.
  77.  
  78. SunOS/SPARC Notes:
  79.  
  80. Note: The regular release of CMU CL does not run on SPARC 10 systems, since
  81. the stack has been moved.  Pick up the file 16f-sun4m_413.core.Z,
  82. uncompress it, and use it instead of the lisp.core from the regular
  83. release.
  84.  
  85. At least 16 meg of memory is recommended, and more is better.  Your system
  86. maintainer may need to configure extra paging space for large Lisp application.
  87.  
  88. It is not possible to mmap a file in a tmpfs filesystem.  If /tmp is a "tmpfs"
  89. filesystem, then you must setenv CMUCL_EMPTYFILE to the pathname of some file
  90. (in a normal filesystem) that can be used instead of /tmp/empty.  The "df"
  91. command will show tmpfs filesystems as mounted on "swap".  If this problem
  92. exists on your system, lisp will get an error like:
  93.     mapin: mmap: Invalid argument
  94.     ensure_space: Failed to validate 67108864 bytes at 0x01000000
  95.  
  96.  
  97. Running CMU CL:
  98.  
  99. Run "lisp".  If Hemlock is loaded, you can also "lisp -edit".  Hemlock will
  100. use X if the DISPLAY environment variable is defined, otherwise it will use
  101. terminal i/o based on TERM and /etc/termcap.
  102.  
  103. Source availability:
  104.  
  105. Lisp and documentation sources are available via anonymous FTP ftp to any CMU
  106. CS machine.  [See the "Distribution" section for FTP instructions.]  All CMU
  107. written code is public domain, but CMU CL also makes use of two imported
  108. packages: PCL and CLX.  Although these packages are copyrighted, they may be
  109. freely distributed without any licensing agreement or fee.
  110.  
  111. The release area contains a source distribution, which is an image of all the
  112. ".lisp" source files used to build version 16f:
  113.     16f-source.tar.Z (3.6 meg)
  114.  
  115. All of our files (including the release area) are actually in the AFS file
  116. system.  On the release machines, the FTP server's home is the release
  117. directory: /afs/cs.cmu.edu/project/clisp/release.  The actual working source
  118. areas are in other subdirectories of "clisp", and you can directly "cd" to
  119. those directories if you know the name.  Due to the way anonymous FTP
  120. access control is done, it is important to "cd" to the source directory with a
  121. single command, and then do a "get" operation.
  122.  
  123. Totally machine-independent compiler code:
  124.     /afs/cs/project/clisp/src/beta/compiler/*.lisp
  125. See especially node.lisp and ir1tran.lisp for the front end.  vop.lisp,
  126. vmdef.lisp and ir2tran.lisp for the back end.
  127.  
  128. Stuff that is dependent on our choice of object format, but not
  129. particularly machine-dependent:
  130.     /afs/cs/project/clisp/src/beta/compiler/generic/*.lisp
  131.  
  132. Compiler back-end for the PMAX and SPARC:
  133.     /afs/cs/project/clisp/src/beta/compiler/mips/*.lisp
  134.     /afs/cs/project/clisp/src/beta/compiler/sparc/*.lisp
  135.  
  136. Miscellaneous Lisp run-time code:
  137.     /afs/cs/project/clisp/src/beta/code/*.lisp
  138.  
  139. C run-time code:
  140.     /afs/cs/project/clisp/src/beta/ldb/*
  141.  
  142. A very drafty version of an internal design document: (160 pages) Some of
  143. the "tex" files may be more humanly readable, since many formatting
  144. commands need to be added.  There is some inaccurate (dated) material in
  145. the compiler description.
  146.     /afs/cs/project/clisp/hackers/ram/docs/internals/*.tex
  147.     /afs/cs/project/clisp/hackers/ram/docs/internals/design.ps
  148.  
  149. See hackers/ram/docs/internals/architecture.tex (the System Architecture
  150. chapter in the internals document) for more information on the source tree
  151. organization.
  152.